eWarranty Vehicle Look Up
ANZ Detailed description of API:
Version & Updates
| Version | Revision Date | Revision History |
|---|---|---|
| 1.0 | 14th July 2026 | New Release |
Overview
Warranty Vehicle Lookup API is designed to allow dealers to retrieve warranty information from the CNH SAP eWarranty system in real time using a Vehicle Identification Number (VIN). The API provides information for the selected VIN, including Repair History, PiP, PPP, Vehicle Description, End Customer Details, and Warranty Data.
The API provides information about:
- Vehicle details
- Warranty information
- Repair history
- Product Improvement Programs (PiP)
- Planned Protection Programs (PPP)
- End Customer details
for the requested VIN.
Note: The API does not return data for VINs manufactured prior to 2012.
Please refer to the diagram below for the data flow of this interface.
Pre-requisites
- Dealer must use their Dealer Portal credentials to authorize the API call.
- Each DMS provider will have a subscription_key assigned by the CNH team. Please contact dlnadmssupport@cnh.com for assistance.
- Each subscription key is unique to the DMS provider and environment.
- Users within the Ownership Group must have accepted CNH's Data Acknowledgement (ANZ only).
Authentication
- DMS must pass Basic Authentication in the HTTP header using username/password.
- DMS providers must include the assigned subscription_key in the HTTP header.
- Dealer Portal users configure the User ID and Password for DMS interface access.
- DEP API validates both Basic Authentication credentials and the subscription key.
API Format
- REST
The DEP processes REST requests and returns REST responses. REST is the supported interface for all new and existing integrations.
Connection Details
Endpoint
| Environment | API URL | Request Type |
|---|---|---|
| UAT / Staging | https://{base_url}/anzexternal/services/warranty/vehiclelookup/{serialnumber} | POST |
| Production | https://{base_url}/anzexternal/services/warranty/vehiclelookup/{serialnumber} | POST |
Request
REST Endpoint
POST https://{base_url}/anzexternal/services/warranty/vehiclelookup/{serialnumber}
Request Parameters
| Name | Parameter Type | Type | Required | Description |
|---|---|---|---|---|
| workshopCode | Query Parameter | String | No | Workshop Code |
Response Structure
| Name | Type | Description |
|---|---|---|
| zcnWtDmsVehicleLookupResponse.vehicleHeader.vehicleNumber | CHAR (10) | SAP INTERNAL VEHICLE NBR (UINQUE) |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.materialNumber | CHAR (18) | FDP/SAP Product (above commercial model) |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.materialNumberDesc | CHAR (40) | FDP Description |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.ldp | CHAR (18) | Product Hierarchy |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.ldpDesc | CHAR (40) | Product Hierarchy Description |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.dealer | CHAR (10) | SAP Dealer Code |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.dealerName | CHAR (35) | SAP Dealer Name |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.serialNumber | CHAR (35) | Vehicle Identification Number (Vehicle Identification No.) |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.vehicleSearchArea | CHAR (10) | Vehicle Search Area |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.commercialModel | CHAR (30) | Commercial Model |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.salesOrg | CHAR (04) | Sales Organization |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.warrantyStartDate | CHAR (10) | Warranty Start Date |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.technicalType | CHAR (10) | Technical Type |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.technicalTypeDesc | CHAR (40) | Technical Type description |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.registrationType | CHAR (10) | Registration Type |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.servicingDealer | CHAR (12) | Partner |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.servicingDealerName | CHAR (35) | Service Dealer Name 1 |
| zcnWtDmsVehicleLookupResponse.vehicleHeader.17serialnum | CHAR (35) | 17 digited - Vehicle Identification Number (Vehicle Identification No.) |
| zcnWtDmsVehicleLookupResponse.VehicleServices.serviceDescription | CHAR (40) | Description for reference |
| zcnWtDmsVehicleLookupResponse.VehicleServices.service | CHAR (18) | Service number |
| zcnWtDmsVehicleLookupResponse.VehicleServices.warrantyType | CHAR (02) | Sort sequence |
| zcnWtDmsVehicleLookupResponse.VehicleServices.serviceDuration | CHAR (30) | Characteristic Value |
| zcnWtDmsVehicleLookupResponse.VehicleServices.serviceStartDate | CHAR (30) | Characteristic Value |
| zcnWtDmsVehicleLookupResponse.VehicleServices.serviceEndDate | CHAR (30) | Characteristic Value |
| zcnWtDmsVehicleLookupResponse.VehicleServices.mileageOrHours | CHAR (30) | Characteristic Value |
| zcnWtDmsVehicleLookupResponse.VehicleServices.serviceEvent | CHAR (03) | Laboratory/design office |
| zcnWtDmsVehicleLookupResponse.VehicleServices.grid | CHAR (20) | Services-vehicle association grid |
| zcnWtDmsVehicleLookupResponse.VehicleServices.gridEvent | CHAR (03) | Laboratory/design office |
| zcnWtDmsVehicleLookupResponse.VehicleServices.monthsPlusMinus | CHAR (05) | Months (+/-) |
| zcnWtDmsVehicleLookupResponse.VehicleServices.masterWarranty | CHAR (20) | Master warranty number |
| zcnWtDmsVehicleLookupResponse.VehicleServices.deductible | CHAR (10) | Numerical field (length 6) |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.cnhClaimNbr | CHAR (12) | CNH SAP Claim Dealer (Unique) |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.dealerClaimNbr | CHAR (10) | Processing Status of Warranty Claim |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.claimProcessingStatus | CHAR (04) | Description of Processing Status of Warranty Claim |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.claimStatusDescription | CHAR (40) | Description of Processing Status of Warranty Claim |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.dealerCode | CHAR (10) | Partner |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.dealerName | CHAR (35) | Data Element Type CHAR Length 35 |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.warrantyType | CHAR (04) | Refer below Warranty Types table |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.warrantyTypeDescription | CHAR (40) | Warranty Type Description |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.vehcileInDate | CHAR (10) | Vehicle In for Repair |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.vehicleHoursAtRepair | NUM (10) | Vehicle HOURS at Repair Time |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.defectCode | CHAR (40) | Defect Code Number |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.failureDescription | CHAR (100) | Failure description |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.totalAmountApproved | NUM (13,2) | Total Amount Approved. This field will be blank if the claim does not belong to the dealer making the inquiry |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.totalLaborApproved | NUM (13,2) | Total Labor Approved. This field will be blank if the claim does not belong to the dealer making the inquiry |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.totalMaterialApproved | NUM (13,2) | Total Material Approved. This field will be blank if the claim does not belong to the dealer making the inquiry |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.totalExtrworkApproved | NUM (13,2) | Total External Work Approved. This field will be blank if the claim does not belong to the dealer making the inquiry |
| zcnWtDmsVehicleLookupResponse.RepairHistoryTable.eligibleFor | CHAR (40) | eligibleFor |
| zcnWtDmsVehicleLookupResponse.PipTable.pipInternalNbr | CHAR (12) | PiP internal ID |
| zcnWtDmsVehicleLookupResponse.PipTable.pipNbr | CHAR (40) | PiP number |
| zcnWtDmsVehicleLookupResponse.PipTable.pipRefDate | CHAR (10) | Reference date |
| zcnWtDmsVehicleLookupResponse.PipTable.pipExpirationDate | CHAR (10) | Expiration date |
| zcnWtDmsVehicleLookupResponse.PipTable.pipDescription | CHAR (60) | Full description of PiP |
| zcnWtDmsVehicleLookupResponse.PipTable.pipExecutionStatus | CHAR (01) | Status of PiP campaign |
| zcnWtDmsVehicleLookupResponse.PipTable.inDate | CHAR (10) | Date field for PiP |
| zcnWtDmsVehicleLookupResponse.PipTable.pipDealer | CHAR (10) | Dealer PiP |
| zcnWtDmsVehicleLookupResponse.PipTable.dealerClaimNumber | CHAR (10) | Dealer PiP number |
| zcnWtDmsVehicleLookupResponse.PipTable.vehicleStolenDate | CHAR (10) | Date of theft |
| zcnWtDmsVehicleLookupResponse.PipTable.vehicleStolenIndicator | CHAR (01) | Theft indicator |
| zcnWtDmsVehicleLookupResponse.PipTable.pipType | CHAR (04) | Pip Type |
| zcnWtDmsVehicleLookupResponse.PipTable.pipSeverity | CHAR (60) | Pip Severity |
| zcnWtDmsVehicleLookupResponse.endCustomer.endCustomerCode | CHAR (10) | Business Partner Number |
| zcnWtDmsVehicleLookupResponse.endCustomer.endCustomerName | CHAR (40) | Name 1 |
| zcnWtDmsVehicleLookupResponse.endCustomer.endCustomerStreet | CHAR (60) | Street |
| zcnWtDmsVehicleLookupResponse.endCustomer.endCustomerCity | CHAR (40) | City |
| zcnWtDmsVehicleLookupResponse.endCustomer.endCustomerState | CHAR (03) | Region (State, Province, County) |
| zcnWtDmsVehicleLookupResponse.endCustomer.endCustomerPostalcode | CHAR (10) | City postal code |
| zcnWtDmsVehicleLookupResponse.endCustomer.endCustomerCountry | CHAR (03) | Country Key |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.vhcle | CHAR (10) | Initial Vehicle Number |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.serialNum | CHAR (35) | Serial Number |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.type | CHAR (35) | Type |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.model | CHAR (30) | Model |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.regisType | CHAR (3) | Registration |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.contractNum | CHAR (35) | Contract Number |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.recordId | CHAR (35) | Record Id |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.numMoths | CHAR (3) | No. of Months |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.numHours | CHAR (9) | No. of Hours |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.cover | CHAR (50) | Coverage |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.deduc | CHAR (10) | Deductible |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.startDat | DATE (10) | Start Date |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.endDat | DATE (10) | End Date |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.serviceFee | NUM (13,2) | Service Fee |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.coverNotes | CHAR (50) | Cover Notes |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.tttmInd | CHAR (10) | TTTM Indicator |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.brand | CHAR (10) | Brand |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.usedInd | CHAR (10) | Used Indicator |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.numHoursFrom | NUM (13,2) | Number of Hours From |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.mpsId | CHAR (10) | MPS Id |
| zcnWtDmsVehicleLookupResponse.VehiclePpp.tcId | CHAR (10) | TC Id |
| zcnWtDmsVehicleLookupResponse.ReturnMessages.Type | CHAR (1) | Return Message Type I – Information E – Exception |
| zcnWtDmsVehicleLookupResponse.ReturnMessages.Message | CHAR (100) | Return Message |
| zcnWtDmsVehicleLookupResponse.ReturnMessages.Number | CHAR (3) | Return Message Number |
| zcnWtDmsVehicleLookupResponse.genericSerial | CHAR (40) | Generic Serial |
Warranty Types
| Warranty Type | Warranty Type Description |
|---|---|
| 0 | Maintenance |
| 1 | Customer warranty |
| 2 | Vendor/manufacturer warranty |
| 3 | High Voltage Components |
| 4 | Velcourt |
| 5 | EV Batteries |
| 6 | Optional Service |
| 7 | Service Assignment Rule (open logic) |
| 8 | Service Assignment Rule (closed logic) |
| 9 | Vehicle master warranty |
| A | Base Warranty |
| B | Extra Base Warranty |
| C | Technical Policy |
| D | Parts Warranty |
| E | Emissions Warranty |
| F | Maintenance SMO |
| G | Standard Extended Warranty |
| H | PIP |
| I | Extended Warranty |
| J | Dealer Demo |
| K | Breakdown assistance |
| L | Rent-to-Own |
| M | Service Quote (Case Care) |
| N | Non-serialized Attachments |
| O | Backhoe boom |
| P | Ultrashield Inspection |
| Q | Major assembly parts warranty |
| R | Purchased Warranty |
| S | Service Coupon |
| T | Commercial Policy |
| U | Ultrashield/Custom Care |
| V | CNH Demo |
| W | Wholegoods Shortage |
| X | WARRANT Programs |
| Y | PPP Warranty |
| Z | P.D.I |
Sample REST Response
Download eWarranty Vehicle Lookup REST SampleResponse Codes
The API returns standard HTTP response codes indicating the status of the request.
| Status Code | Message |
|---|---|
| 200 | Response body returned successfully |
Incorrect Serial Number - Please Check Input Serial Number - Invalid Value Entered {Serial Number} | |
| 400 | Required request body missing |
| Invalid JSON format in request body | |
| User not setup - Please contact SAP DMS Support Team | |
Please check Input Serial Number - Invalid Value Entered {Provided VIN} | |
Please try later - Valid Serial, but not yet ready for warranty {Provided VIN} | |
Please check Input Serial Number - Appears to be duplicate - WS does not support {Provided VIN} | |
| 401 | Access denied due to invalid credentials |
| Access denied due to missing subscription key | |
| 500 | Internal Server Error |